home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cgeevx.z / cgeevx
Text File  |  1996-03-14  |  9KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGEEVX - compute for an N-by-N complex nonsymmetric matrix A, the
  10.      eigenvalues and, optionally, the left and/or right eigenvectors
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGEEVX( BALANC, JOBVL, JOBVR, SENSE, N, A, LDA, W, VL, LDVL,
  14.                         VR, LDVR, ILO, IHI, SCALE, ABNRM, RCONDE, RCONDV,
  15.                         WORK, LWORK, RWORK, INFO )
  16.  
  17.          CHARACTER      BALANC, JOBVL, JOBVR, SENSE
  18.  
  19.          INTEGER        IHI, ILO, INFO, LDA, LDVL, LDVR, LWORK, N
  20.  
  21.          REAL           ABNRM
  22.  
  23.          REAL           RCONDE( * ), RCONDV( * ), RWORK( * ), SCALE( * )
  24.  
  25.          COMPLEX        A( LDA, * ), VL( LDVL, * ), VR( LDVR, * ), W( * ),
  26.                         WORK( * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      CGEEVX computes for an N-by-N complex nonsymmetric matrix A, the
  30.      eigenvalues and, optionally, the left and/or right eigenvectors.
  31.  
  32.      Optionally also, it computes a balancing transformation to improve the
  33.      conditioning of the eigenvalues and eigenvectors (ILO, IHI, SCALE, and
  34.      ABNRM), reciprocal condition numbers for the eigenvalues (RCONDE), and
  35.      reciprocal condition numbers for the right
  36.      eigenvectors (RCONDV).
  37.  
  38.      The right eigenvector v(j) of A satisfies
  39.                       A * v(j) = lambda(j) * v(j)
  40.      where lambda(j) is its eigenvalue.
  41.      The left eigenvector u(j) of A satisfies
  42.                    u(j)**H * A = lambda(j) * u(j)**H
  43.      where u(j)**H denotes the conjugate transpose of u(j).
  44.  
  45.      The computed eigenvectors are normalized to have Euclidean norm equal to
  46.      1 and largest component real.
  47.  
  48.      Balancing a matrix means permuting the rows and columns to make it more
  49.      nearly upper triangular, and applying a diagonal similarity
  50.      transformation D * A * D**(-1), where D is a diagonal matrix, to make its
  51.      rows and columns closer in norm and the condition numbers of its
  52.      eigenvalues and eigenvectors smaller.  The computed reciprocal condition
  53.      numbers correspond to the balanced matrix.  Permuting rows and columns
  54.      will not change the condition numbers (in exact arithmetic) but diagonal
  55.      scaling will.  For further explanation of balancing, see section 4.10.2
  56.      of the LAPACK Users' Guide.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  75.      BALANC  (input) CHARACTER*1
  76.              Indicates how the input matrix should be diagonally scaled and/or
  77.              permuted to improve the conditioning of its eigenvalues.  = 'N':
  78.              Do not diagonally scale or permute;
  79.              = 'P': Perform permutations to make the matrix more nearly upper
  80.              triangular. Do not diagonally scale; = 'S': Diagonally scale the
  81.              matrix, ie. replace A by D*A*D**(-1), where D is a diagonal
  82.              matrix chosen to make the rows and columns of A more equal in
  83.              norm. Do not permute; = 'B': Both diagonally scale and permute A.
  84.  
  85.              Computed reciprocal condition numbers will be for the matrix
  86.              after balancing and/or permuting. Permuting does not change
  87.              condition numbers (in exact arithmetic), but balancing does.
  88.  
  89.      JOBVL   (input) CHARACTER*1
  90.              = 'N': left eigenvectors of A are not computed;
  91.              = 'V': left eigenvectors of A are computed.  If SENSE = 'E' or
  92.              'B', JOBVL must = 'V'.
  93.  
  94.      JOBVR   (input) CHARACTER*1
  95.              = 'N': right eigenvectors of A are not computed;
  96.              = 'V': right eigenvectors of A are computed.  If SENSE = 'E' or
  97.              'B', JOBVR must = 'V'.
  98.  
  99.      SENSE   (input) CHARACTER*1
  100.              Determines which reciprocal condition numbers are computed.  =
  101.              'N': None are computed;
  102.              = 'E': Computed for eigenvalues only;
  103.              = 'V': Computed for right eigenvectors only;
  104.              = 'B': Computed for eigenvalues and right eigenvectors.
  105.  
  106.              If SENSE = 'E' or 'B', both left and right eigenvectors must also
  107.              be computed (JOBVL = 'V' and JOBVR = 'V').
  108.  
  109.      N       (input) INTEGER
  110.              The order of the matrix A. N >= 0.
  111.  
  112.      A       (input/output) COMPLEX array, dimension (LDA,N)
  113.              On entry, the N-by-N matrix A.  On exit, A has been overwritten.
  114.              If JOBVL = 'V' or JOBVR = 'V', A contains the Schur form of the
  115.              balanced version of the matrix A.
  116.  
  117.      LDA     (input) INTEGER
  118.              The leading dimension of the array A.  LDA >= max(1,N).
  119.  
  120.      W       (output) COMPLEX array, dimension (N)
  121.              W contains the computed eigenvalues.
  122.  
  123.      VL      (output) COMPLEX array, dimension (LDVL,N)
  124.              If JOBVL = 'V', the left eigenvectors u(j) are stored one after
  125.              another in the columns of VL, in the same order as their
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              eigenvalues.  If JOBVL = 'N', VL is not referenced.  u(j) =
  141.              VL(:,j), the j-th column of VL.
  142.  
  143.      LDVL    (input) INTEGER
  144.              The leading dimension of the array VL.  LDVL >= 1; if JOBVL =
  145.              'V', LDVL >= N.
  146.  
  147.      VR      (output) COMPLEX array, dimension (LDVR,N)
  148.              If JOBVR = 'V', the right eigenvectors v(j) are stored one after
  149.              another in the columns of VR, in the same order as their
  150.              eigenvalues.  If JOBVR = 'N', VR is not referenced.  v(j) =
  151.              VR(:,j), the j-th column of VR.
  152.  
  153.      LDVR    (input) INTEGER
  154.              The leading dimension of the array VR.  LDVR >= 1; if JOBVR =
  155.              'V', LDVR >= N.
  156.  
  157.              ILO,IHI (output) INTEGER ILO and IHI are integer values
  158.              determined when A was balanced.  The balanced A(i,j) = 0 if I > J
  159.              and J = 1,...,ILO-1 or I = IHI+1,...,N.
  160.  
  161.      SCALE   (output) REAL array, dimension (N)
  162.              Details of the permutations and scaling factors applied when
  163.              balancing A.  If P(j) is the index of the row and column
  164.              interchanged with row and column j, and D(j) is the scaling
  165.              factor applied to row and column j, then SCALE(J) = P(J),    for
  166.              J = 1,...,ILO-1 = D(J),    for J = ILO,...,IHI = P(J)     for J =
  167.              IHI+1,...,N.  The order in which the interchanges are made is N
  168.              to IHI+1, then 1 to ILO-1.
  169.  
  170.      ABNRM   (output) REAL
  171.              The one-norm of the balanced matrix (the maximum of the sum of
  172.              absolute values of elements of any column).
  173.  
  174.      RCONDE  (output) REAL array, dimension (N)
  175.              RCONDE(j) is the reciprocal condition number of the j-th
  176.              eigenvalue.
  177.  
  178.      RCONDV  (output) REAL array, dimension (N)
  179.              RCONDV(j) is the reciprocal condition number of the j-th right
  180.              eigenvector.
  181.  
  182.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  183.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  184.  
  185.      LWORK   (input) INTEGER
  186.              The dimension of the array WORK.  If SENSE = 'N' or 'E', LWORK >=
  187.              max(1,2*N), and if SENSE = 'V' or 'B', LWORK >= N*N+2*N.  For
  188.              good performance, LWORK must generally be larger.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCGGGGEEEEEEEEVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206.      RWORK   (workspace) REAL array, dimension (2*N)
  207.  
  208.      INFO    (output) INTEGER
  209.              = 0:  successful exit
  210.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  211.              > 0:  if INFO = i, the QR algorithm failed to compute all the
  212.              eigenvalues, and no eigenvectors or condition numbers have been
  213.              computed; elements 1:ILO-1 and i+1:N of W contain eigenvalues
  214.              which have converged.
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.